/*
 * Copyright (C) 2019 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.android.tools.idea.npw.template.components

import com.android.tools.idea.observable.AbstractProperty
import javax.swing.JComponent

/**
 * An interface for providing a Swing component and an [AbstractProperty] that controls it.
 * To use this class, simply call [createComponent] and [createProperty] with the component it returns.
 */
abstract class ComponentProvider<T : JComponent> {
  abstract fun createComponent(): T

  open fun createProperty(component: T): AbstractProperty<*>? = null

  /**
   * Gives subclasses a chance to handle the user accepting the current value. Most components
   * won't do anything but some may save their values into a Recents database, for example.
   */
  open fun accept(component: T) {}
}
